Skip to content

docs: generate llms.txt and llms-full.txt#465

Merged
sriramveeraghanta merged 1 commit into
masterfrom
docs/add-llms-txt
Jun 18, 2026
Merged

docs: generate llms.txt and llms-full.txt#465
sriramveeraghanta merged 1 commit into
masterfrom
docs/add-llms-txt

Conversation

@sriramveeraghanta

@sriramveeraghanta sriramveeraghanta commented Jun 18, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

What

Adds llms.txt and llms-full.txt to the docs site, generated at build time and served at:

These give LLMs and AI search engines (ChatGPT, Perplexity, AI Overviews) a clean, structured view of the documentation.

How

Uses vitepress-plugin-llms wired into vite.plugins in docs/.vitepress/config.ts:

  • domain set to https://docs.plane.so for absolute URLs in the index.
  • description / details provide a richer, spec-compliant blockquote + summary.
  • generateLLMFriendlyDocsForEachPage: false — the existing buildEnd hook already copies per-page .md into dist/ for the Accept: text/markdown rewrite in vercel.json, so the plugin owns only the two aggregate files (no overlap).
  • injectLLMHint: false — rendered pages are left untouched.
  • ignoreFiles — the three noindex / search: false pages (core-concepts/issues, core-concepts/projects/run-project, importers/github-imp) are excluded, matching their search-engine treatment.

Output

  • llms.txt: 113 documentation links (~6.6K tokens, ~25 kB)
  • llms-full.txt: 113 pages (~180K tokens, ~762 kB)
  • Home page excluded (plugin default); HTML/Vue components stripped from the full bundle.

Both files are emitted into the gitignored dist/ on every pnpm build, so they always stay in sync with the docs — nothing to maintain by hand.

Notes

  • pnpm check:format passes.
  • The plugin only lists local doc pages in llms.txt, so external sidebar links (Developer docs, Blog, marketplace) are not included — can add a custom template later if we want them.

Summary by CodeRabbit

  • Chores
    • Integrated a new plugin into the documentation build system to enhance documentation processing capabilities.
    • Added development dependency for documentation tooling.

@sriramveeraghanta
docs: generate llms.txt and llms-full.txt
28b0f2e 
Add vitepress-plugin-llms to produce llms.txt (a curated, sidebar-ordered
index) and llms-full.txt (full docs concatenated) at build time, served at
docs.plane.so/llms.txt and /llms-full.txt for LLM/GEO consumption.

- Plugin owns llms.txt / llms-full.txt only; the existing buildEnd .md copy
  still serves the Accept: text/markdown rewrite, so per-page generation is
  disabled to avoid overlap.
- domain set for absolute URLs; richer description/details for the index.
- noindex / search:false pages excluded via ignoreFiles.
- injectLLMHint disabled to keep rendered pages untouched.
@vercel

vercel Bot commented Jun 18, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 18, 2026 2:47pm

Request Review

@coderabbitai

coderabbitai Bot commented Jun 18, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 266639b8-20f9-4c91-bab6-690a2a3bb850

📥 Commits

Reviewing files that changed from the base of the PR and between 2213583 and 28b0f2e.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • docs/.vitepress/config.ts
  • package.json
📝 Walkthrough

Walkthrough

Adds vitepress-plugin-llms (v1.13.1) as a dev dependency and registers the llmstxt plugin in the VitePress vite.plugins configuration. The plugin is set up with domain, description, and details metadata, with per-page doc generation and LLM hint injection disabled, and an explicit list of markdown files excluded from the generated outputs.

Changes

LLM text output integration

Layer / File(s) Summary
Dependency and plugin configuration
package.json, docs/.vitepress/config.ts		 Adds vitepress-plugin-llms ^1.13.1 to devDependencies, imports the plugin in the VitePress config, and wires it under vite.plugins with domain/description/details metadata, generateLLMFriendlyDocsForEachPage: false, injectLLMHint: false, and an ignoreFiles array.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop hop, the docs now speak to LLMs,
A llms.txt born from config gems,
Some pages ignored, some details set right,
The plugin now hums through the VitePress night.
With a twitch of my nose, the build outputs glow! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: generate llms.txt and llms-full.txt' accurately summarizes the main change: adding plugin configuration to automatically generate two LLM-friendly documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-llms-txt

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sriramveeraghanta sriramveeraghanta merged commit 6eeedd4 into master Jun 18, 2026
5 checks passed
@sriramveeraghanta sriramveeraghanta deleted the docs/add-llms-txt branch June 18, 2026 14:57
@sriramveeraghanta sriramveeraghanta mentioned this pull request Jun 18, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danciaclara danciaclara danciaclara approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sriramveeraghanta @danciaclara